<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="PaprikaSpice,jp.raohmaru.motion.PaprikaSpice,ease,onComplete,onCompleteParams,onStart,onUpdate,scope,useFrames,progress" name="keywords">
<title>jp.raohmaru.motion.PaprikaSpice</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'PaprikaSpice - Raohmaru AS3 Framework';
				var baseRef = '../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">Raohmaru AS3 

Framework</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?jp/raohmaru/motion/PaprikaSpice.html&amp;jp/raohmaru/motion/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;PaprikaSpice</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class PaprikaSpice"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">jp.raohmaru.motion</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class PaprikaSpice</td>
</tr>
</table>
<p></p>
 La especia que necesita Paprika para funcionar. Formalmente, la clase PaprikaSpice representa un objeto con los parámetros para la interpolación
 del objeto de destino.
 <p></p>
<br>
<span class="label">Example</span>
<br><div class='listing'><pre>
import jp.raohmaru.motion.Paprika;
import jp.raohmaru.motion.easing.Circ;<br>
var spice :PaprikaSpice = Paprika.add(some_mc, 1, {autoAlpha:0});
    spice.ease = Circ.easeInOut;
    spice.onComplete = function() :void
    {
     // ...
    }</pre></div>
 <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#ease">ease</a> : Function<div class="summaryTableDescription">
  La ecuación de movimiento a utilizar en la interpolación.</div>
</td><td class="summaryTableOwnerCol">PaprikaSpice</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#onComplete">onComplete</a> : Function<div class="summaryTableDescription">
  Función que será invocada automáticamente al finalizar la animación.</div>
</td><td class="summaryTableOwnerCol">PaprikaSpice</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#onCompleteParams">onCompleteParams</a> : Array<div class="summaryTableDescription">
  Matriz con los parámetros a enviar a la función definida en <code>onComplete</code>.</div>
</td><td class="summaryTableOwnerCol">PaprikaSpice</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#onStart">onStart</a> : Function<div class="summaryTableDescription">
  Función que se invoca al inicio de la interpolación.</div>
</td><td class="summaryTableOwnerCol">PaprikaSpice</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#onUpdate">onUpdate</a> : Function<div class="summaryTableDescription">
  Función que se invoca durante la interpolación.</div>
</td><td class="summaryTableOwnerCol">PaprikaSpice</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#progress">progress</a> : Number<div class="summaryTableDescription">[read-only]
  Obtiene el progreso de la interpolación, un valor que va del 0 (inicio) al 1 (fin).</div>
</td><td class="summaryTableOwnerCol">PaprikaSpice</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#scope">scope</a> : Object<div class="summaryTableDescription">
  Objeto al que se aplica la función definida en <code>onComplete</code>.</div>
</td><td class="summaryTableOwnerCol">PaprikaSpice</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#useFrames">useFrames</a> : Boolean<div class="summaryTableDescription">
  Determina si la duración de la interpolación debe ser en segundos (<code>false</code>) o en fotogramas (<code>true</code>);
  </div>
</td><td class="summaryTableOwnerCol">PaprikaSpice</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#PaprikaSpice()">PaprikaSpice</a>()</div>
<div class="summaryTableDescription">
  Crea una nueva instancia de la especia PaprikaSpice.</div>
</td><td class="summaryTableOwnerCol">PaprikaSpice</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="ease"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">ease</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>public var ease:Function</code><p>
  La ecuación de movimiento a utilizar en la interpolación. Están incluidas en la librería en el paquete jp.raohmaru.motion.easing.
  </p></div>
<a name="onComplete"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onComplete</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var onComplete:Function</code><p>
  Función que será invocada automáticamente al finalizar la animación.
  </p></div>
<a name="onCompleteParams"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onCompleteParams</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var onCompleteParams:Array</code><p>
  Matriz con los parámetros a enviar a la función definida en <code>onComplete</code>.
  </p></div>
<a name="onStart"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onStart</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var onStart:Function</code><p>
  Función que se invoca al inicio de la interpolación. El objeto al que se aplica la función es el definido por el parámetro <code>scope</code>.
  Los parámetros enviados se definen con la propiedad <code>onCompleteParams</code>.
  </p></div>
<a name="onUpdate"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onUpdate</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var onUpdate:Function</code><p>
  Función que se invoca durante la interpolación. El objeto al que se aplica la función es el definido por el parámetro <code>scope</code>.
  Los parámetros enviados se definen con la propiedad <code>onCompleteParams</code>.
  </p><br>
<span class="label">Example</span>
<br> <div class='listing'><pre>
 import jp.raohmaru.motion.Paprika;<br>
 Paprika.add(some_mc, 1, {color:0xFFCC00}).onUpdate = onUpdate;
 function onUpdate() :void
 {
     // ...
 }</pre></div>
  <p></p>
</div>
<a name="progress"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">progress</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>progress:Number</code>&nbsp;&nbsp;[read-only]<p>
  Obtiene el progreso de la interpolación, un valor que va del 0 (inicio) al 1 (fin).
  </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get progress():Number</code>
<br>
</div>
<a name="scope"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">scope</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var scope:Object</code><p>
  Objeto al que se aplica la función definida en <code>onComplete</code>. Dentro de la función, <code>this</code> representará a este objeto.
  </p></div>
<a name="useFrames"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">useFrames</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var useFrames:Boolean</code><p>
  Determina si la duración de la interpolación debe ser en segundos (<code>false</code>) o en fotogramas (<code>true</code>);
  </p><br>
<span class="label">Example</span>
<br> <div class='listing'><pre>
 import jp.raohmaru.motion.Paprika;<br>
 Paprika.add(some_mc, 1, {scaleX:0}).useFrames = true;
 var spice :PaprikaSpice = Paprika.add(other_mc, 1, {alpha:1});
     spice.useFrames = true;</pre></div>
  <p></p>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="PaprikaSpice()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">PaprikaSpice</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function PaprikaSpice()</code><p>
  Crea una nueva instancia de la especia PaprikaSpice. Cada vez que se invoca el método <code>Paprika.add()</code> se genera un nuevo objeto PaprikaSpice.
  </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="Paprika.html#add()" target="">Paprika.add()</a>
</div>
<br>
<span class="label">Example</span>
<br> <div class='listing'><pre>
 import jp.raohmaru.motion.Paprika;<br>
 var spice :PaprikaSpice = Paprika.add(some_mc, 1, {y:-110});</pre></div>
  <p></p>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">http://www.raohmaru.com</center>
</div>
</body>
</html>
<!--http://www.raohmaru.com-->
